/*
 * Copyright © 2017 camunda services GmbH (info@camunda.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.camunda.zeebe.client.api.response;

import java.util.List;

/**
 * @deprecated since 8.8 for removal in 8.10, replaced by {@link
 *     io.camunda.client.api.response.DocumentReferenceBatchResponse}
 */
@Deprecated
public interface DocumentReferenceBatchResponse {

  /**
   * @return true if all documents were successfully uploaded
   */
  boolean isSuccessful();

  /**
   * @return the documents that were successfully uploaded
   */
  List<DocumentReferenceResponse> getCreatedDocuments();

  /**
   * @return the documents that were not uploaded
   */
  List<FailedDocumentDetail> getFailedDocuments();

  interface FailedDocumentDetail {

    /**
     * @return the filename of the failed document
     */
    String getFileName();

    /**
     * @return the failure description
     */
    String getDetail();
  }
}
